/*
Copyright (c) 2012 the VATSIM Connector project

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#ifndef __LIBVATCONN__LIBVATCONN_H__
#define __LIBVATCONN__LIBVATCONN_H__

enum { vconMaxMsgSize = 512 };

/**
 * Enum type for representing one of the weather message subtypes.
 */
enum VconWxMsgSubtype
{
  vconWxMETAR = 0,  ///< message is the METAR subtype
  vconWxCLOUDS,	    ///< message is the clouds subtype
  vconWxWINDS,	    ///< message is the winds subtype
  vconWxTEMPS,	    ///< message is the temperatures subtype
  vconWxInvalid = -1  ///< invalid message subtype
};

/**
 * Class for representing squawk code parameters in messages.
 *
 * We don't just use a plain `int` because we want to specialize the
 * stringification of squawks to add leading zeros.
 */
struct VconSquawk
{
  int code; //< squawk code (0-7777 with decimal digits 0-7 only)
};

/**
 * Class for representing radio frequency parameters in messages.
 *
 * We don't just use a plain `int` or `float` because we want to specialize
 * the stringification of frequencies to add leading and trailing zeros.
 */
struct VconFreq
{
  int kHz;  //< frequency in kHz (123450 kHz = 123.450 MHz)
};

#endif //__LIBVATCONN__LIBVATCONN_H__